Inside Macintosh: QuickTime /

Chapter 2 - Movie Toolbox / Movie Toolbox Reference

Functions for Getting and Playing Movies / Movies and Your Event Loop

PtInMovie

The PtInMovie function allows your application to determine whether a specified point lies in the region defined by a movie's final display boundary region after it has been clipped by the movie's display clipping region. This function is accurate at the current movie time.

pascal Boolean PtInMovie (Movie theMovie, Point pt);

theMovie

Specifies the movie for this operation. Your application obtains this movie identifier from such functions as NewMovie, NewMovieFromFile, and NewMovieFromHandle (described on page 2-80, page 2-76, and page 2-78, respectively).

pt

Specifies the point to be checked. This point must be expressed in the movie's local display coordinate system.

DESCRIPTION

The PtInMovie function returns a Boolean value. The function sets this value to true if the point lies in the movie's display space.

SPECIAL CONSIDERATIONS

The region that PtInMovie checks for is different from the movie box.

ERROR CODES

invalidMovie

-2010

This movie is corrupted or invalid

SEE ALSO

To find out if a point lies in the region defined by a track's display boundary region after it has been clipped by a movie's final display clipping region, you use the PtInTrack function. See the next section for details.